Skip to content

Improve user experience in Get Started guide for NGF #799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Jul 11, 2025
Merged

Improve user experience in Get Started guide for NGF #799

merged 7 commits into from
Jul 11, 2025
+128 −21

Conversation

shaun-nx
Copy link
Contributor

@shaun-nx shaun-nx commented Jul 9, 2025

Closes #788

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩

@shaun-nx shaun-nx requested a review from a team as a code owner July 9, 2025 10:08
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Jul 9, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 9, 2025 •
edited
Loading

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@shaun-nx shaun-nx added documentation Improvements or additions to documentation customer-success and removed documentation Improvements or additions to documentation labels Jul 9, 2025
@shaun-nx
Copy link
Contributor Author

shaun-nx commented Jul 9, 2025

I have hereby read the F5 CLA and agree to its terms

@shaun-nx shaun-nx requested review from ADubhlaoich, ciarams87, tataruty and AlexFenlon and removed request for a team July 9, 2025 10:09
@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 9, 2025

✅ Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/799/

ADubhlaoich
ADubhlaoich approved these changes Jul 9, 2025
View reviewed changes
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Please keep conventional commits in mind when merging this for the sake of a correctly formatted title.

mjang
mjang reviewed Jul 9, 2025
View reviewed changes
ADubhlaoich
ADubhlaoich approved these changes Jul 9, 2025
View reviewed changes
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still generally LGTM: edit suggestions to make the explanations of the command output sequential and more concise.

@shaun-nx shaun-nx merged commit a1bb1da into main Jul 11, 2025
10 checks passed
@shaun-nx shaun-nx deleted the ngf/get-started-commands branch July 11, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mjang mjang mjang left review comments

@JTorreG JTorreG JTorreG approved these changes

@ADubhlaoich ADubhlaoich ADubhlaoich approved these changes

@ciarams87 ciarams87 Awaiting requested review from ciarams87

@tataruty tataruty Awaiting requested review from tataruty

@AlexFenlon AlexFenlon Awaiting requested review from AlexFenlon

Assignees
No one assigned
Labels
customer-success documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve user experience in Get Started guide for NGF
4 participants
@shaun-nx @ADubhlaoich @mjang @JTorreG